xr_api_wrapper.h File Reference

#include "log-settings/log_defs.h"
#include "xr-runtime-common/xr_api_defs.h"
#include "xr-runtime-common/xr_platform_option.h"
#include "xr-runtime-common/xr_runtime_option.h"
#include <vector>

Go to the source code of this file.

Namespaces
namespace	sony::oz
	API.
namespace	sony
namespace	sony::oz::xr_runtime

Functions
	XR_DEFINE_HANDLE (SonyOzSessionHandle)
SonyOzResult	sony::oz::xr_runtime::LinkXrLibrary (SonyOzPlatformId platform_id)
	Link the library and make the API available.
void	sony::oz::xr_runtime::UnlinkXrLibrary ()
	Terminate use of XR API and unlink the library.
SonyOzResult	sony::oz::xr_runtime::GetDeviceNum (SonyOzPlatformId platform_id, uint64_t *num)
	Get the number of available devices.
SonyOzResult	sony::oz::xr_runtime::EnumerateDevices (SonyOzPlatformId platform_id, uint64_t size, SonyOzDeviceInfo *device_list)
	Obtain information on available devices.
SonyOzResult	sony::oz::xr_runtime::SetDebugLogCallback (SonyOzPlatformId platform_id, SonyOzLogSettings_LogCallback callback)
	Change the log output destination to the specified function.
SonyOzResult	sony::oz::xr_runtime::CreateSession (SonyOzPlatformId platform_id, const SonyOzDeviceInfo *device, RUNTIME_OPTION_BIT_FLAG runtime_option_bit_flag, PLATFORM_OPTION_BIT_FLAG platform_option_bit_flag, SonyOzSessionHandle *session)
	Create session with XR Platform.
SonyOzResult	sony::oz::xr_runtime::DestroySession (SonyOzSessionHandle *session)
	Destroy session with XR Platform.
SonyOzResult	sony::oz::xr_runtime::BeginSession (SonyOzSessionHandle session)
	Start a session with the XR Platform.
SonyOzResult	sony::oz::xr_runtime::EndSession (SonyOzSessionHandle session)
	Terminate the session with XR Platform.
SonyOzResult	sony::oz::xr_runtime::GetSessionState (SonyOzSessionHandle session, SonyOzSessionState *session_state)
	Obtain session status.
SonyOzResult	sony::oz::xr_runtime::UpdateTrackingResultCache (SonyOzSessionHandle session)
	Update the cache of tracking data.(for Game Thread)
SonyOzResult	sony::oz::xr_runtime::GetCachedPose (SonyOzSessionHandle session, SonyOzPoseId pose_id, SonyOzPosef *pose, bool *is_valid)
	Obtain information about the camera.
SonyOzResult	sony::oz::xr_runtime::GetProjection (SonyOzSessionHandle session, SonyOzPoseId pose_id, SonyOzProjection *projection)
	Obtain Projection.
SonyOzResult	sony::oz::xr_runtime::SubmitD3d11 (SonyOzSessionHandle session, ID3D11Device *device, ID3D11Texture2D *side_by_side, bool flip_y_position, ID3D11Texture2D *target)
	Generate render textures and shaders for D3D11. (single pass)
SonyOzResult	sony::oz::xr_runtime::SubmitD3d12 (SonyOzSessionHandle session, ID3D12CommandQueue *command_queue, uint32_t node_mask, ID3D12Resource *side_by_side, bool flip_y_position, DXGI_FORMAT format, ID3D12Resource *target)
	Generate render textures and shaders for D3D11. (single pass)
SonyOzResult	sony::oz::xr_runtime::SubmitOpengl (SonyOzSessionHandle session, unsigned int side_by_side, bool flip_y_position, unsigned int target)
	Generate render textures and shaders for D3D11. (single pass)
SonyOzResult	sony::oz::xr_runtime::SubmitMultiPassD3d11 (SonyOzSessionHandle session, ID3D11Device *device, ID3D11Texture2D *left, ID3D11Texture2D *right, bool flip_y_position, ID3D11Texture2D *target)
	Generate D3D11 render textures and shaders for off-screen rendering and shaders. (multi-pass)
SonyOzResult	sony::oz::xr_runtime::SubmitMultiPassD3d12 (SonyOzSessionHandle session, ID3D12CommandQueue *command_queue, uint32_t node_mask, ID3D12Resource *left, ID3D12Resource *right, bool flip_y_position, DXGI_FORMAT format, ID3D12Resource *target)
	Generate D3D12 render textures and shaders for off-screen rendering and shaders. (multi-pass)
SonyOzResult	sony::oz::xr_runtime::SubmitMultiPassOpengl (SonyOzSessionHandle session, unsigned int left, unsigned int right, bool flip_y_position, unsigned int target)
	Generate render textures and shaders for D3D11. (single pass)
SonyOzResult	sony::oz::xr_runtime::EnableStereo (SonyOzSessionHandle session, bool enable)
	Enables/disables stereo rendering.
SonyOzResult	sony::oz::xr_runtime::GetTargetMonitorRectangle (SonyOzSessionHandle session, SonyOzRect *rect)
	Obtain information on the target monitor.
SonyOzResult	sony::oz::xr_runtime::GetDisplaySpec (SonyOzSessionHandle session, SonyOzDisplaySpec *display_spec)
	Obtain information about the display.
SonyOzResult	sony::oz::xr_runtime::GetXrSystemError (SonyOzSessionHandle session, SonyOzXrSystemError *error)
	Obtain an error occurred in XR Runtime.
SonyOzResult	sony::oz::xr_runtime::GetXrSystemErrorNum (SonyOzSessionHandle session, uint16_t *num)
	Obtain the number of errors occured in XR Runtime.
SonyOzResult	sony::oz::xr_runtime::GetXrSystemErrorList (SonyOzSessionHandle session, uint16_t num, SonyOzXrSystemError *errors)
	Obtain errors occurred in XR Runtime.
SonyOzResult	sony::oz::xr_runtime::SetColorSpace (SonyOzSessionHandle session, int input_gamma_count, int output_gamma_count, float gamma)

Detailed Description

Copyright

Sony CONFIDENTIAL

Copyright 2019,2020,2021 Sony Corporation

DO NOT COPY AND/OR REDISTRIBUTE WITHOUT PERMISSION.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `‘AS IS’' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

XR_DEFINE_HANDLE()

XR_DEFINE_HANDLE

(

SonyOzSessionHandle

)